Package-level declarations

Result of Terminal.abort/Terminal.abortAsync.

Identifies the user opening a shift with Terminal.activate.

Result of Terminal.activate/Terminal.activateAsync.

Amount to charge, in minor units, together with its currency.

Result and callbacks for asynchronous connection, shift and terminal administration operations. Payments use TransactionHandle; pre-transactions use PreTransactionHandle.

Card information returned with a completed purchase.

Result of Terminal.connect/Terminal.connectAsync.

Result of Terminal.deactivate/Terminal.deactivateAsync.

Result of Terminal.disconnect/Terminal.disconnectAsync.

Cardholder display update pushed by the terminal while a purchase is running (for example "insert card", "processing"), delivered to Terminal.Builder.onDisplayContent - independent of TerminalState/Terminal.Builder.onStateChanged, which only ever tracks connection/shift lifecycle, never per-transaction display updates.

Reason why a purchase did not succeed.

Result of Terminal.finalBalance/Terminal.finalBalanceAsync.

Connection settings accepted by Terminal.Builder.connectionOptions. Use RemoteConnectionOptions for an HTTP(S) terminal service.

Receives log messages from the SDK, set via Terminal.Builder.logger.

Severity passed to ILogger.log.

Loyalty card data collected during a pre-transaction wait, available through PreTransactionResult.getLoyaltyData.

What to collect ahead of the actual payment amount being known, passed to Terminal.startPreTransaction/Terminal.startPreTransactionAsync. See PreTransactionAction for the individual data points that can be requested.

Fluent, lambda-friendly builder passed into the configurer of Terminal.startPreTransactionAsync - mirrors TransactionCall, but for the background wait started ahead of a transaction instead of the transaction itself.

Returned by Terminal.startPreTransactionAsync. Wraps the background wait's eventual outcome so callers that want to wait synchronously can do so with join/get - mirrors TransactionHandle, but for the pre-transaction wait, and offers the same getResult/cancel as PreTransactionProgress on the sync side.

Handle returned immediately by Terminal.startPreTransaction.

What to collect ahead of the actual payment amount being known, passed to Terminal.startPreTransaction/Terminal.startPreTransactionAsync.

Outcome of the background wait started by Terminal.startPreTransaction/ Terminal.startPreTransactionAsync, retrieved via PreTransactionProgress.getResult (or PreTransactionHandle.getResult on the async side).

Details about a failed or declined payment.

Result of Terminal.reboot/Terminal.rebootAsync.

A receipt produced by the terminal.

Connects over HTTP(S) to a terminal-service deployment, authenticating with the OAuth2 client-credentials grant against tokenUrl - required, since Terminal.connect always needs a token to reach the terminal service.

What to reverse with Terminal.startReversal/Terminal.startReversalAsync.

Result of Terminal.startReversal/Terminal.startReversalAsync.

What to run with Terminal.startServiceRequest/Terminal.startServiceRequestAsync - build one via configure, configureOnly or initialiseOnly, each only exposing the parameters that make sense for that kind of service request (for example, acquirerId has no meaning for configureOnly and is therefore not accepted there at all).

Result of Terminal.startServiceRequest/Terminal.startServiceRequestAsync. Contains the combined receipts of whichever step(s) ran (configuration and/or initialisation).

Which step(s) Terminal.startServiceRequest/Terminal.startServiceRequestAsync should run - see ServiceRequest.

Which party needs to sign a payment receipt. A null TransactionResult.signatureRequirement means no information was reported; NONE explicitly means no signature is required.

Entry point of the APA POS SDK. Create one instance per terminal and reuse it; instances are thread-safe.

Raised when an operation could not be completed, for example because the terminal service was unreachable, rejected the credentials or sent an unreadable response.

Timeouts, receipt formatting and payment settings for a Terminal.

Local connection/shift lifecycle state, as tracked by Terminal.getState and reported to Terminal.Builder.onStateChanged.

The requested operation is unavailable. Thrown before any request is sent. Repeating the same call does not resolve this error.

Configures transaction callbacks. Completion is reported only after the commit decision is resolved.

Tracks a transaction until its final outcome. join/get and onComplete receive the same result. A deferred transaction remains pending until commit or rollback resolves the decision. Use onWaitingForCommit for authorisation data; do not wait on join before making that decision.

Payment request passed to Terminal.startTransaction or Terminal.startTransactionAsync. Use the factory for the payment type, such as purchase or purchaseWithCashback. The constructor enforces the same rules as the builders. Reversals use ReversalRequest.

Result shared by synchronous and asynchronous transactions, commit, rollback and recovery. status is the transaction state; FAILED includes declines and aborts, not just technical errors. A WAITING_FOR_COMPLETION reservation requires a separate completion operation. Card and authorisation details are preserved when confirming a commit. Missing recovery data remains null. authorisedAt and completedAt describe distinct events.

Current outcome of a transaction, as reported by Terminal.fetchTransactionStatus.

Result of Terminal.fetchTransactionStatus: the current, already-persisted state of a transaction, resolved by its ECR transaction id without repeating or affecting it in any way.

A pending authorisation or a transaction result.

Whether the transaction needs a decision or has an outcome.

Payment type. Use a TransactionRequest factory to select one. REVERSAL uses the separate Terminal.startReversal operation.

Authorisation awaiting a commit/rollback decision. Call exactly one of commit or rollback. Both block until the service reports the outcome or the configured commit timeout expires.

Passed to TransactionCall.onWaitingForCommit once the terminal has approved or declined a transaction started with autoCommit = false. Return a WaitingForCommitResult to commit, roll back, or defer the decision. Also available from UncommittedTransactionResult.getTrxData.

Decision returned from TransactionCall.onWaitingForCommit: commit, roll back, or leave the transaction pending for a later TransactionHandle.commit or TransactionHandle.rollback.